.cm KERMITCM
.cs 1 on
Last revision: Version 4.2.2 (91/8/19)
.sp 1
Kermit-CMS is a program that implements the KERMIT file transfer
protocol for IBM 370-series mainframes running the VM/CMS operating
system.  It allows for the transfer of files between computers over
asynchronous ASCII communications lines (attached
to a 3705-style front end, such as the COMTEN, or to any of a wide
variety of protocol convertors, such as the Series/1
running the Yale ASCII Terminal Communication System).
For more details, see the section SET CONTROLLER.
.sp 1
.cs 1 off
.cs 2 on
The calling format for Kermit-CMS is:
.sp 1
        +----------------------------------+
        |          |                       |
        |  KERMIT  |  [kercmd ... kercmd]  |
        |          |                       |
        +----------------------------------+
.sp 1
where kercmd is a valid Kermit-CMS subcommand.  If no Kermit subcommands are
supplied, Kermit-CMS will issue a prompt and wait for instructions.
When Kermit is invoked with command line arguments, it
will exit and return to CMS after completing the
specified subcommand or subcommands.  Several subcommands may be given on the
command line as long as they are separated by the linend character.
The command line may contain up to 130 characters.
.sp 1
You may use the help ("?")  feature while typing Kermit-CMS subcommands.
A question mark typed at almost any point in a subcommand, followed by a
carriage return, produces a brief description of what is expected or
possible at that point.
.sp 1
.cs 2 off
.cs 5 on
Usage Notes:
.sp 1
.of 4
1.  To use CMS Kermit though a 3705-style linemode connection,
you should set the following parameters in your local (micro) Kermit:
LOCAL-ECHO ON (half duplex),
FLOW-CONTROL NONE (rather
than XON/XOFF), HANDSHAKE Ctrl-Q, TIMER ON, and whatever PARITY is
necessary.
.sp 1
.of 4
2.  To use CMS Kermit through a protocol converter, use
LOCAL-ECHO OFF (full duplex), FLOW-CONTROL XON/XOFF, HANDSHAKE NONE,
TIMER ON, and whatever PARITY is necessary.
.sp 1
.of 4
3.  Five CP SET parameters (MSG, IMSG, WNG, ACNT, and TIMER) are set
OFF during protocol mode (and restored afterwards).  The last two are
skipped under VM/XA.
In addition, RUN is set ON, and,
on a TTY line, the TERMINAL LINESIZE is set OFF and the
CMS user terminal translation tables are suppressed.
.sp 1
.of 4
4.  The current version of Kermit-CMS does not support timeouts.  Your
local Kermit program should supply them (SET TIMER ON enables timeouts
in most microcomputer Kermits).
.sp 2
.of 0
See the syntax and descriptions for Kermit subcommands individually...
.sp 1
.cs 5 off
.cs 3 on
.cm SEN
.of 8
SEND [fn ft [fm][<[n][-m][_CC]>]] [foreign-filespec][, ...]
.sp 1
Send a file or file group from the CMS system to the Kermit on the
remote system.  The wildcard characters "*" or "%" may be used.  A "*"
matches any string of characters from the current position to the end
of the field, including no characters at all; a "%" matches any single
character.  If the input contains wildcard characters, then all
matching files will be sent.  If the optional filemode is omitted,
the home disk is normally used (but see under SET SEARCH-ALL).
The exact file name to be sent to
the foreign Kermit system may be specified;
otherwise, Kermit-CMS will make it up out of the CMS name.
An optional range of lines within each file may be specified; only
those lines will be sent.  Also, optionally, column-one ASA carriage
control may be converted to formatting control characters via the CC
option.
.sp 1
.cm REC
.of 8
RECEIVE [fn ft [fm]]
.sp 1
Receive a file or file group from the other system.  If the optional
filename is not included, Kermit-CMS will use the name(s) provided by
the other Kermit.  If that name is not a legal CMS file name,
Kermit-CMS will delete excessive characters from it, and will change
illegal characters to underscores.  Use the file specification to
indicate that the incoming file should be stored under a different
name.  The filespec may include a filemode to designate the
destination disk.  If none is provided, the file will be saved on the
"home" disk with filemode number 1.  If you want to use the same name
but a different filemode, specify "= = FM", where FM is the access
mode of the destination disk.  Wildcards may not be used in any field.
If the optional filespec is provided, but more than one file arrives,
the first file will be stored under the given filespec, and the
remainder will be stored under their own names on the home disk.  If,
however, "= = FM" is used, all files will be placed onto the specified
disk.
.sp 1
.cm TA
.of 8
TAKE fn ft [fm]
.sp 1
Execute Kermit subcommands from the specified file.  The command file may
include TAKE subcommands.  If the filespec omits the type, it is assumed
to be TAKE.
.sp 1
.cm SER
.of 8
SERVER
.sp 1
Kermit-CMS is capable of acting as a server.  In server mode,
Kermit-CMS can send and receive files, execute CP/CMS commands,
execute a restricted set of Kermit subcommands, and perform a variety of
generic Kermit functions.  The following list shows the typical local
Kermit subcommands along with the server functions they elicit.  Note
that when Kermit-CMS is talking to a Kermit server, these same
subcommands may be used in the other direction.
.sp
  BYE                 log out of CMS
  FINISH              exit from server mode
  GET                 send a file or files from CMS
  REMOTE COPY         copy a file or files
  REMOTE CWD          set new "home" disk
  REMOTE DIRECTORY    display file attributes
  REMOTE ERASE        delete a file or files
  REMOTE HELP         display this command summary
  REMOTE HOST         execute a CP/CMS command
  REMOTE KERMIT       execute a Kermit-CMS subcommand
  REMOTE PRINT        send a file to be printed under CMS
  REMOTE RENAME       rename a file or files
  REMOTE SPACE        display disk allocations
  REMOTE TYPE         display a file
  SEND                receive a file or files onto CMS
.sp
If your local Kermit does not support the REMOTE KERMIT subcommand, you
may need to issue SET subcommands to select various options before typing
the SERVER subcommand.  Once in server mode, Kermit-CMS will await all
further instructions from the user Kermit on the other end of the
connection.
.sp 1
.cm BYE
.of 8
BYE
.sp 1
Cause the other (server) Kermit to exit and log off.
.sp 1
.cm FIN
.of 8
FINISH
.sp 1
Cause the other (server) Kermit to end server mode.
.sp 1
.cm G
.of 8
GET [foreign-filespec [fn ft [fm]]]
.sp 1
Request a file from another Kermit running in server mode.  The result
is similar to that of typing RECEIVE to Kermit-CMS and then SEND to
another Kermit.
.sp 1
.cm STOP
.of 8
STOP
.sp 1
(Not really a subcommand.)  Cause Kermit-CMS to leave protocol mode
immediately, thereby canceling any active transfer and ending server
mode if necessary.
.sp 1
.cm CW
.of 8
CWD letter
.sp 1
Change Working Directory - establish new default ("home") CMS disk, A
by default.
.sp 1
.cm SET
.of 8
SET parameter [[sub-parameter] value]
.sp 1
Establish or modify various parameters for file transfer.  You can
examine their values with the SHOW subcommand.  The default/initial
values of ON/OFF switches are OFF unless otherwise noted.
.sp 1
.of 0
See details for individual parameters ...
.sp 1
.in 4
.cm SETATOE
.of 6
SET ATOE [num1 num2]
.sp 1
Modify the ASCII-to-EBCDIC translate table used by Kermit-CMS to
conform to your system.  Specify the offset of the ASCII value within
the table and the new value for that location.  Both "num1" and
"num2" should be in the range 0-255 (decimal).  If "num1" and "num2"
are omitted, restore the table to its default values.  Tables ETOA,
TATOE, and TETOA may be modified in the same way.
.sp 1
.cm SETETOA
.of 6
SET ETOA - see SET ATOE.
.sp 1
.cm SETTATOE
.of 6
SET TATOE - see SET ATOE.
.sp 1
.cm SETTETOA
.of 6
SET TETOA - see SET ATOE.
.sp 1
.cm SETATT
.of 6
SET ATTRIBUTE [attribute] <ON | OFF>
.sp 1
Tells whether to generate A-packets or specific attributes within
A-packets.  Enter "SET ATT ? ?" for a list of attributes.
.sp 1
.cm SETB
.of 6
SET BLOCK num
.sp 1
Determine the type of block check used during file transfer.  Valid
options for "num" are: 1 (for a one-byte checksum), 2 (for a two-byte
checksum) and 3 (for a three-byte CRC).
.sp 1
.cm SETCON
.of 6
SET CONTROLLER <TTY | SERIES1 | GRAPHICS | AEA>
.sp 1
Kermit-CMS automatically determines whether you are connected via a
Series/1-style emulation controller or a TTY line.  This subcommand is
provided, though, so you can change connections and because Kermit may
not be able to distinguish between Series/1 and graphics throughput
devices.  For both those and the 3174 AEA,
Kermit attempts to disable the 3270 protocol conversion function by
putting the controller into "transparent mode"; this allows Kermit
packets to pass through intact.
.sp 1
.cm SETD
.of 6
SET DEBUG <ON | OFF | RAW | I/O | LONG | SAVE | TIME>
.sp 1
If ON, keep a journal of all packets sent and received in the file KER
LOG A1.  If the file already exists, it is overwritten.  If OFF, stop
logging the packets.  If RAW, same as ON, but record packets "exactly"
as sent or received (without translating to EBCDIC).  If I/O, same as
ON, but record extra information about transmission for non-TTY line.
If LONG, same as I/O, but don't truncate the buffer dumps at 36 bytes.
If SAVE, same as ON, but close KER LOG after each output line.
If TIME, the I/O records (if any) are given time tags.  RAW,
I/O, TIME, SAVE, and/or LONG may be combined in one setting.
.sp 1
.cm SETDEL
.of 6
SET DELAY num
.sp 1
How long to wait before sending the first packet.  Use a DELAY of 0 to
suppress the extra 1-second pause for issuing the protocol-mode
greetings.
.sp 1
.cm SETDEST
.of 6
SET DESTINATION letter
.sp 1
Specify "home" disk.
.sp 1
.cm SETEOF
.of 6
SET EOF <ON | OFF>
.sp 1
ON means incoming text files are to be cut off at first Ctrl-Z
character within the data; OFF means accept incoming text files in
their entirety.
.sp 1
.cm SETW
.of 6
SET WARNING - (obsolete) see SET FILE COLLISION.
.sp 1
.cm SETAPP
.of 6
SET APPEND - (obsolete) see SET FILE COLLISION.
.sp 1
.cm SETRECF
.of 6
SET RECFM - see SET FILE RECFM.
.sp 1
.cm SETL
.of 6
SET LRECL - see SET FILE LRECL.
.sp 1
.cm SETF
.of 6
SET FILE COLLISION <APPEND | BACKUP | DISCARD | OVERWRITE | RENAME>
.sp 0
Specifies the action to take when a file is received that has the same
name as an existing one.  BACKUP and RENAME are similar, but BACKUP
renames the old file while RENAME renames the new one.  OVERWRITE is
the default.
.sp 1
.of 6
SET FILE LONGLINE <TRUNC | FOLD | HALT>
.sp 0
Specifies the action to take when a record is received that is too long.
The default is TRUNC.
.sp 1
.of 6
SET FILE LRECL num
.sp 0
Set the logical record length for incoming files to a "num" from
1 to 65535 (64K-1).  This variable is used only for fixed format and
binary files.  The default is 80.
.sp 1
.of 6
SET FILE OVERWRITE <DEFAULT | PRESERVE>
.sp 0
Specifies what attributes to use when writing a new file over
an old one.  DEFAULT is the default.
.sp 1
.of 6
SET FILE RECFM <FIXED | VARIABLE>
.sp 0
Sets the record format to use for incoming files, using "F" for fixed
length and "V" for variable length.  The default is variable.
.sp 1
.of 6
SET FILE CHARACTER-SET name
.sp 0
Specifies the character set to use for storing TEXT files received.
See also SET TRANSFER CHARACTER-SET.
.sp 1
.of 6
SET FILE TYPE <BINARY | TEXT | V-BINARY | D-BINARY>
.sp 0
If BINARY, CMS Kermit treats each character as a string of bits and
does not perform translation on the data.  Also, carriage returns are
not added to the end of outgoing records.  Incoming bytes are added to
the end of the current record which is written out when the specified
LRECL is reached.  If TEXT, CMS Kermit treats the file as plain text;
ASCII-to-EBCDIC and EBCDIC-to-ASCII translation is performed on the
data.  A carriage return-linefeed is appended to each outgoing record
and is used to determine the end of each incoming record.  V-BINARY
specifies variable-length-record binary data (like BINARY, except that
a 2-byte length field precedes each outbound record and is assumed
for incoming records).  D-BINARY is similar, but the length field is a
5-byte ASCII decimal string.
.sp 1
.cm SETFOR
.of 6
SET FOREIGN <PREFIX | SUFFIX> string
.sp 0
The specified string is added to the beginning or end of outbound filespecs.
.sp 1
.cm SETH
.of 6
SET HANDSHAKE number
.sp 0
Specifies the ASCII code for a handshake character to be appended to
each outgoing packet.  Zero means no handshake at all.
.sp 1
.cm SETINC
.of 6
SET INCOMPLETE <KEEP | DISCARD>
.sp 0
Specifies the action to take when a file transfer is cancelled.
.sp 1
.cm SETLIN
.of 6
SET LINE cuu
.sp 0
Specifies a device other than the user's terminal for file transfer.
.sp 1
.cm SETM
.of 6
SET MARGIN <LEFT | RIGHT> column
.sp 0
The specified margin is set for restricting the width of files to be
sent.  A value of zero disables the specified margin.
.sp 1
.cm SETPR
.of 6
SET PROMPT string
.sp 0
Defines the character string that Kermit-CMS displays when
asking for a subcommand.  The prompt may be any string of up to 20
characters.  The default is "Kermit-CMS>" (with XON appended).  The
current HANDSHAKE character, if any, is appended to any new string,
if necessary.
.sp 1
.cm SETSEN
.of 6
SET <SEND | RECEIVE> END-OF-LINE num
.sp 0
If the remote system needs packets to be terminated by anything other
than carriage return, specify the decimal value of the desired ASCII
character.  "num" must be in the range 0 - 31 (decimal).
.sp 1
.of 6
SET <SEND | RECEIVE> PACKET-SIZE num
.sp 0
Use the specified "num" as the maximum length for incoming packets.
The valid range is 26-1913, and 80 is the default.  SET RECEIVE
PACKET-SIZE 95 or greater causes Kermit-CMS to negotiate reception
of extended length packets with other Kermit programs that support
this option.  SEND PACKET-SIZE should almost never be specified.
.sp 1
.of 6
SET <SEND | RECEIVE> PAD-CHAR num
.sp 0
Padding character to use between packets, NUL (ASCII 0) by default.
.sp 1
.of 6
SET <SEND | RECEIVE> PADDING num
.sp 0
Number of copies of the interpacket padding character, zero by default.
.sp 1
.of 6
SET <SEND | RECEIVE> PARITY <MARK | NONE>
.sp 0
Transparent-mode ASCII data from a SERIES1 or GRAPHICS device will
typically have either all Mark parity (seven data bits with the eighth
bit set) or no parity (eight data bits).  Kermit-CMS must know which
kind of parity to expect in order to calculate checksums properly.
Kermit-CMS does not verify the parity bits.
.sp 1
.of 6
SET <SEND | RECEIVE> QUOTE char
.sp 0
Control character quoting prefix, normally #.
.sp 1
.of 6
SET <SEND | RECEIVE> START-OF-PACKET num
.sp 0
Control character to mark start of packet, normally Ctrl-A (ASCII 1).
.sp 1
.of 6
SET <SEND | RECEIVE> TIMEOUT num
.sp 0
Number of seconds to wait for a packet before retransmitting.
.sp 1
.cm SETREC
.of 6
The syntax for SET RECEIVE is the same as for SET SEND.
.sp 1
.cm SETRET
.of 6
SET RETRY <INITIAL | PACKET> num
.sp 0
Threshold for retrying a particular packet.  The default
is 16 for initial and 5 for ordinary packets.
.sp 1
.cm SETSEA
.of 6
SET SEARCH-ALL <ON | OFF>
.sp 0
Tells whether all disks should be searched when filemode omitted from
SEND or GET filespec, or only the "home" disk.
.sp 1
.cm SETSP
.of 6
SET SPEED num
.sp 0
Line transmission speed assumed in the packet-size
optimization code.  If given as 0, no optimization.  Default: 1200.
.sp 1
.cm SETBA
.of 0
SET BAUD is a synonym for SET SPEED.
.sp 1
.cm SETSY
.of 6
SET SYSCMD <ON | OFF>
.sp 0
Determines whether non-Kermit commands are assumed to be
CP/CMS commands (and passed along to CMS or CP for execution).
.sp 1
.cm SETT
.of 6
SET TABS-EXPAND <ON | OFF>
.sp 0
Controls whether tabs in incoming text files are expended to blanks.
.sp 1
.cm SETTAK
.of 6
SET TAKE ECHO <ON | OFF>
.sp 0
Controls whether the contents of TAKE command files are echoed during
execution.
.sp 1
.of 6
SET TAKE ERROR-ACTION <CONTINUE | HALT>
.sp 0
Controls whether an error occurring during execution of a TAKE command
file is fatal to the execution of that file.  The default is CONTINUE.
.sp 1
.cm SETTEST
.of 6
SET TEST <ON | OFF>
.sp 0
Used for testing new versions, suppresses block check verification,
allows start-of-packet to be set to anything at all.
.sp 1
.cm SETTR
.of 6
SET TRANSFER CHARACTER-SET name
.sp 0
Character set to use for sending and receiving TEXT files.
See also FILE CHARACTER-SET.
.sp 1
.cm SETTT
.of 6
SET TTABLE <ON | OFF | KP>
.sp 0
Controls whether ATOE/ETOA or TATOE/TETOA are used for counteracting
the system translations on TTY lines.  KP is like ON, but also changes
the TATOE/TETOA tables to values based on Hollerith codes.
.sp 1
.cm SET8
.of 6
SET 8-BIT-QUOTE <ON | OFF | char>
.sp 0
Controls whether eighth-bit prefixing is done and
specifies the character to be used.
.sp 1
.in 0
.cm SH
.of 8
SHOW [option]
.sp 1
Display the values of any or all parameters that can be changed with
the SET subcommand, except for ATOE and ETOA (see the TDUMP subcommand).
If no option is specified, all parameters except the Attribute flags
are displayed.
.sp 1
.cm SP
.of 8
SPACE [letter]
.sp 1
Show the storage allocation on the specified CMS disk.
.sp 1
.cm ST
.of 8
STATUS
.sp 1
Return the status of the previous subcommand.  The response will
display the statistics from the last transfer plus the
message "No errors" or the last error encountered.
.sp 1
.cm TD
.of 8
TDUMP <table-name | NAMES>
.sp 1
Display the contents of "table-name" since it can be modified using
the SET subcommand.  The ATOE, ETOA, TATOE, and TETOA tables can be
'dumped' (also, the list of files sent in the last transfer).
.sp 1
.cm GI
.of 8
GIVE table-name fn [ft [fm]]
.sp 1
Save the contents of "table-name" as a TAKE file containing SET
subcommands to change the default into the current arrangement.
.sp 1
.cm XE
.of 8
XECHO line
.sp 1
Displays the line at your terminal as a "raw" transfer
according to the current CONTROLLER setting.  Control characters
within the line are specified by prefixing "^".  See also ECHO.
.sp 1
.cm EC
.of 8
ECHO line
.sp 0
Displays the line at your terminal.  See also XECHO.
.sp 1
.cm XT
.of 8
XTYPE fn ft [fm][<[n][-m][_CC]>]
.sp 1
Displays the specified file at your terminal as a "raw" transfer
according to the current CONTROLLER setting.  The syntax for options
in angle brackets <> is the same as that for the SEND subcommand.
See also TYPE.
.sp 1
.cm TY
.of 8
TYPE fn fm [ft] [( options]
.sp 1
Displays the specified file (up to 130 characters per line)
at your terminal.  This is identical to the CMS TYPE command,
including all options.
See also XTYPE.
.sp 1
.cm CM
.of 8
CMS     Issue a CMS command from within Kermit-CMS.
.sp 1
.cm CP
.of 8
CP      Issue a CP command from within Kermit-CMS.
.sp 1
.cm HO
.of 8
HOST    Issue a CP/CMS command from within Kermit-CMS.
.sp 1
.cm DIR
.of 8
DIR     Same as CMS LISTFILE.
.sp 1
.cm H
.of 8
HELP    Displays a message that explains Kermit-CMS subcommands.
.sp 1
.cm EX
.of 8
EXIT    Exits from KERMIT back to the host operating system.
.sp 1
.cm Q
.of 8
QUIT    Synonym for EXIT.
.sp 1
.cm VE
.of 8
VERSION Displays the version number and date of Kermit-CMS.
.sp 1
.cm K
.of 8
KERMIT string
.sp 0
Specifies that the string is to be executed as a Kermit subcommand.
.sp 1
.cm LOC
.of 8
LOCAL string
.sp 0
Specifies that the string is to be executed as a Kermit subcommand by
Kermit-CMS (whether it is actually operating as a "local" Kermit or not).
.sp 1
.cm REM
.of 8
REMOTE string
.sp 0
Specifies that the string is to be executed as a subcommand by another
Kermit, operating in server mode.  See under SERVER for a list of the
allowed subcommands.  Note that REMOTE PRINT supports the same options
as SEND in connection with the filespec.
.sp 1
.of 0
.cs 3 off
